Swagger preview version(2020-09-01-preview) for Microsoft.DataBoxEdge #12350
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @pvsraviteja Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The child tracked resource, 'addons' with immediate parent 'Role', must have a list by immediate parent operation. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L3783 |
|
| 'state' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L5155 |
|
| 'registrationDate' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L5169 |
|
| 'subscriptionId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L5172 |
|
| 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L5175 |
|
| 'SubscriptionProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L7920 |
|
| 'tenantId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L7923 |
|
| 'locationPlacementId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L7926 |
|
| 'quotaId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L7929 |
|
| 'serializedDetails' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json#L7932 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️[Staging] Cross Version BreakingChange (Base on preview version): 20 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.5)
- original: preview/2020-05-01-preview/databoxedge.json <---> new: preview/2020-09-01-preview/databoxedge.json
️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 16 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.5)
- original: stable/2019-08-01/databoxedge.json <---> new: preview/2020-09-01-preview/databoxedge.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @pvsraviteja your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @weidongxu-microsoft |
|
Hi @pvsraviteja, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Jan 10, 2021
| @@ -756,12 +756,58 @@ | |||
| } | |||
| } | |||
| }, | |||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate": { | |||
There was a problem hiding this comment.
Are these new API, or API already existed but not documented before?
There was a problem hiding this comment.
This is a new API which is added.
| "operationId": "Devices_GenerateCertificate", | ||
| "parameters": [ | ||
| { | ||
| "name": "deviceName", |
There was a problem hiding this comment.
Suggestion is to put deviceName after resourceGroupName. But if most API in RP is written this way, no need to change.
j5lim
requested changes
Jan 11, 2021
...taboxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json
Show resolved
Hide resolved
...taboxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-09-01-preview/databoxedge.json
Show resolved
Hide resolved
| } | ||
| } | ||
| }, | ||
| "x-ms-long-running-operation": true, |
There was a problem hiding this comment.
Doesn't the API return 'Location' header to track async DELETE?
There was a problem hiding this comment.
Yes it returns location header through which we track the request.
There was a problem hiding this comment.
Then please add "x-ms-long-running-operation-options" : { "final-state-via" : "location" } By default it assumes using Azure-AsyncOperation header.
https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-long-running-operation
There was a problem hiding this comment.
Changed as requested.
| { | ||
| "name": "$expand", | ||
| "in": "query", | ||
| "description": "Specify $filter='CustomContextTag eq <tag>' to filter on custom context tag property", |
There was a problem hiding this comment.
The description is not for $expand.
| { | ||
| "name": "$expand", | ||
| "in": "query", | ||
| "description": "Specify $filter='Type eq <type>' to filter on user type property", |
| "roleName": "IoTRole1", | ||
| "accept-language": [ | ||
| "en-US" | ||
| ] |
There was a problem hiding this comment.
The parameters do not match the example responses.
j5lim
added
the
ARMChangesRequested
25 tasks
mentat9
reviewed
Jan 11, 2021
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "DownloadUpdatesPost": { |
There was a problem hiding this comment.
Example should be for GenerateCertificate
mentat9
reviewed
Jan 11, 2021
| "tags": [ | ||
| "Devices" | ||
| ], | ||
| "description": "Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.", |
There was a problem hiding this comment.
Is Data Box Edge renamed to Azure Stack Edge?
mentat9
reviewed
Jan 11, 2021
| "items": { | ||
| "$ref": "#/definitions/Node" | ||
| }, | ||
| "readOnly": true |
There was a problem hiding this comment.
Consider making this list pageable and adding a next link property
mentat9
reviewed
Jan 12, 2021
| "tags": [ | ||
| "Devices" | ||
| ], | ||
| "description": "Gets additional information for the specified Data Box Edge/Data Box Gateway device.", |
There was a problem hiding this comment.
Action name in URL is "update", not "get". Also, is there a way to GET this info?
There was a problem hiding this comment.
There is only one API which is GetUpdateExtendedInfo. This is existing API and is not added in this iteration.
mentat9
reviewed
Jan 12, 2021
| "properties": { | ||
| "value": { | ||
| "description": "The value of the secret.", | ||
| "type": "string" |
There was a problem hiding this comment.
This should be marked as x-ms-secret and nulled out when present in GET.
pvsraviteja
force-pushed
the
developer/rapvs/PreviewVersion
branch
from
37d4c64 to
b5354c0
Compare
j5lim
added
ARMSignedOff
weidongxu-microsoft
approved these changes
Jan 13, 2021
This was referenced Jan 13, 2021
[ReleasePR databoxedge] add con figuration for databoxedge
Azure/azure-resource-manager-schemas#1335
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.